﻿<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
  <command:command 
    xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
    xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
    xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <!-- Cmdlet details section-->
    
    <command:details>
      <command:name>Get-Tenant</command:name>
      <maml:description>
        <maml:para>Gets Orchard tenants.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>Tenant</command:noun>
      <dev:version></dev:version>
    </command:details>

    <!-- Cmdlet description section-->
    
    <maml:description>
      <maml:para>The Get-Tenant cmdlet gets Orchard tenants.</maml:para>
    </maml:description>

    <!-- Cmdlet syntax section-->
    
    <command:syntax>

      <command:syntaxItem>
        <maml:name>Get-Tenant</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the Orchard tenant to get. This parameter is required.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">string</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>

      <command:syntaxItem>
        <maml:name>Get-Tenant</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Enabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only tenants which are enabled.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
          <maml:name>Disabled</maml:name>
          <maml:description>
            <maml:para>Specifies that the command should get only tenants which are disabled.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>

    </command:syntax>

    <!-- Cmdlet parameters section-->
    
    <command:parameters>
      
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies the name of the Orchard tenant to get.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">string</command:parameterValue>
        <dev:type>
          <maml:name>string</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
        <maml:name>Enabled</maml:name>
        <maml:description>
          <maml:para>Specifies that the command should get only tenants which are enabled.</maml:para>
        </maml:description>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false">
        <maml:name>Disabled</maml:name>
        <maml:description>
          <maml:para>Specifies that the command should get only tenants which are disabled.</maml:para>
        </maml:description>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
      
    </command:parameters>

    <!-- Input - Output section-->
    
    <command:inputTypes />

    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Proligence.PowerShell.Tenants.Items.OrchardTenant</maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
      </command:returnValue>
    </command:returnValues>

    <!-- Error section-->
    
    <command:terminatingErrors />
    <command:nonTerminatingErrors />

    <!-- Notes section  -->

    <maml:alertSet />

    <!-- Example section  -->
    
    <command:examples>
      
      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 1 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-Tenant
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets all Orchard tenants.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 2 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-Tenant foo
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command get the Orchard tenant named 'foo'.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 3 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt; </maml:para>
        </maml:introduction>
        <dev:code>
          Get-Tenant -Enabled
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command gets all Orchard tenants which are enabled.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
      
    </command:examples>

    <!-- Related links section  -->

    <RelatedLinks>
      <navigationLink>
        <linkText>Get-ChildItem</linkText>
        <uri/>
      </navigationLink>
      <navigationLink>
        <linkText>Enable-Tenant</linkText>
        <uri/>
      </navigationLink>
      <navigationLink>
        <linkText>Disable-Tenant</linkText>
        <uri/>
      </navigationLink>
    </RelatedLinks>

  </command:command>
</helpItems>